Get X activity subscriptions

Get a list of active subscriptions for XAA

GET /2/activity/subscriptions

Try it

Get X activity subscriptions

cURL

curl --request GET \
  --url https://api.x.com/2/activity/subscriptions \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "event_type": "<string>",
      "filter": {
        "keyword": "The President",
        "user_id": "2244994945"
      },
      "subscription_id": "1146654567674912769",
      "updated_at": "2023-11-07T05:31:56Z",
      "tag": "<string>",
      "webhook_id": "1146654567674912769"
    }
  ],
  "errors": [
    {
      "title": "<string>",
      "type": "<string>",
      "detail": "<string>",
      "status": 123
    }
  ],
  "meta": {
    "total_subscriptions": 123
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200

application/json

The request has succeeded.

data · object[]

Show child attributes

data. created_at · string<date-time> · required

data. event_type · string · required

data. filter · object · required

An XAA subscription.

Show child attributes

data.filter. keyword · string

A keyword to filter on.

Required string length: 1 - 150

Example:

"The President"

data.filter. user_id · string

Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"2244994945"

data. subscription_id · string · required

The unique identifier of this subscription.

Example:

"1146654567674912769"

data. updated_at · string<date-time> · required

data. tag · string

data. webhook_id · string

The unique identifier of this webhook config.

Example:

"1146654567674912769"

errors · object[]

Minimum array length: 1

Show child attributes

errors. title · string · required

errors. type · string · required

errors. detail · string

errors. status · integer

meta · object

Show child attributes

meta. total_subscriptions · integer<int32>

Number of active subscriptions.