Skip to main content

Get all events

GET 

https://api.publicsquare.com/events

Get a list of events for the Account.

Permissions

  • event:read

Request

Query Parameters

    start_dt string

    Inclusive start date to filter records by

    end_dt string

    Exclusive end date to filter records by

    event_type string[]

    List of event types to filter by

    query string

    Filter by query

    page int32

    Possible values: > 0 and <= 2147483647

    Page

    size int32

    Possible values: > 0 and <= 100

    Page size

Responses

OK

Schema
    pagination object
    total_itemsint32nullable

    Total number of records

    Example: 1020
    page_numberint32nullable

    Current page number

    Example: 23
    page_sizeint32

    Page size

    Example: 20
    total_pagesint32nullable

    Total number of pages

    Example: 51
    data object[]nullable

    Possible values: <= 100

  • Array [
  • idstringnullable

    Event ID

    Example: evnt_5jxWRFNLCAWeegrkCAG3a9DGc
    account_idstringnullable

    Account ID

    Example: acc_B518niGwGYKzig6vtrRVZGGGV
    environmentstringnullable

    Environment - Can be test or production

    Example: production
    event_typestringnullable

    Event type

    Example: connection:update
    entity_typestringnullable

    Entity type of the event

    Example: connection
    entity_idstringnullable

    Entity ID of the event

    Example: conn_73t7igFxDZvN9hypi7yoPwbxy
    entitynullable

    Current entity value of the event

    created_atdate-timenullable

    Date event was created

    Example: 2024-06-30T01:02:29.212Z
  • ]

Authorization: X-API-KEY

name: X-API-KEYtype: apiKeyscopes: event:readdescription: Authorization by API Key inside request's X-API-KEY headerin: header
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.publicsquare.com/events");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-API-KEY", "<X-API-KEY>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://api.publicsquare.com
Auth
Parameters
— query
— query
— query
— query
— query
— query
ResponseClear

Click the Send API Request button above and see the response here!