Get Audiences List

This endpoint is used to get the list of audiences.

POST /linkedin/get_audiences_list

Get Audiences List

cURL

curl --request POST \
  --url https://public.plai.io/linkedin/get_audiences_list \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "userId": "<string>"
}
'

200

{
  "success": true,
  "results": {
    "success": true,
    "audiences": [
      {
        "name": "<string>",
        "sourcePlatform": "<string>",
        "id": 123,
        "type": "<string>",
        "account": "<string>",
        "destinations": [
          {
            "destination": "<string>",
            "lastModified": 123,
            "audienceSize": 123,
            "created": 123,
            "destinationSegmentId": "<string>",
            "status": "<string>",
            "matchedCount": 123
          }
        ],
        "inputCount": 123
      }
    ],
    "error": "<string>"
  }
}

Request Body

userId · string · required

User ID, If not already created, make a user on create user page first. If already created, retrieve the user ID from get profile page.

Response

success · boolean

Indicates that the HTTP response was successful (status code 200 OK).

results · object

Show Results Object

success · boolean

Indicates whether the specific operation or API action was successful.

audiences · object[]

Show Audience Object

name · string

The display name of the audience segment.

sourcePlatform · string

Source platform for the audience (e.g., LINKEDIN_BUSINESS_OBJECTIVE_BASED_AUDIENCES, LIST_UPLOAD).

id · number

The unique numeric identifier for the audience.

type · string

Audience type (e.g., USER, USER_LIST_UPLOAD).

account · string

URN identifier for the associated LinkedIn sponsored account.

destinations · object[]

Show Destination Object

destination · string

Platform where audience is used (e.g., LINKEDIN).

lastModified · number

Timestamp of last modification (epoch milliseconds).

audienceSize · number

Current size of the audience segment.

created · number

Timestamp when audience was created (epoch milliseconds).

destinationSegmentId · string

Unique URN identifier for the destination segment.

status · string

Audience status (e.g., EXPIRED, READY).

matchedCount · number

Number of matched users (for USER_LIST_UPLOAD types).

inputCount · number

Number of inputs provided for USER_LIST_UPLOAD audiences.

error · string

Error string if something went wrong