---
updatedAt: 2026-04-13T12:21:26.000Z
agentTools:
projectIndex: https://docs.company.info/llms.txt
---
# /follow-lists/{follow_list_id}/subscriptions/businesses
# OpenAPI definition
```json
{
"openapi": "3.0.3",
"info": {
"title": "Compliance Monitoring API",
"description": "Compliance Monitoring API",
"version": "2.0.0"
},
"servers": [
{
"url": "https://api.company.info/compliance/monitor/v2"
}
],
"security": [
{
"ApiKeyAuth": []
}
],
"paths": {
"/follow-lists": {
"get": {
"tags": [
"Follow Lists"
],
"parameters": [
{
"name": "page",
"in": "query",
"style": "deepObject",
"description": "`size`defines the number of records to return in each page. default value: 10, maximum value: 20.
`cursor`specifies the next page cursor.",
"schema": {
"$ref": "#/components/schemas/Page"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ListOfFollowList"
}
}
},
"headers": {
"X-Correlation-Id": {
"schema": {
"type": "string",
"format": "uuid",
"description": "Unique request identifier"
}
},
"X-Ratelimit-Limit": {
"schema": {
"type": "integer",
"description": "The number of request available in a rate limit window"
}
},
"X-Ratelimit-Remaining": {
"schema": {
"type": "integer",
"description": "The number of requests left for the rate limit window"
}
},
"X-Ratelimit-Reset": {
"schema": {
"type": "integer",
"description": "The Unix timestamp at which the current rate limit window resets"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/vnd.api+json": {
"schema": {
"title": "JSON:API Error Response",
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"title": "An array of Error objects",
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"required": [
"status",
"code",
"title",
"detail"
],
"properties": {
"status": {
"description": "the HTTP status code applicable to this problem",
"type": "string",
"minLength": 3,
"maxLength": 3
},
"code": {
"description": "an application-specific error code. It can be the same as 'status'",
"type": "string"
},
"title": {
"description": "a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization",
"type": "string"
},
"detail": {
"description": "a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized",
"type": "string"
}
}
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/paths/~1follow-lists/get/responses/400/content/application~1vnd.api%2Bjson/schema"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/paths/~1follow-lists/get/responses/400/content/application~1vnd.api%2Bjson/schema"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/paths/~1follow-lists/get/responses/400/content/application~1vnd.api%2Bjson/schema"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/paths/~1follow-lists/get/responses/400/content/application~1vnd.api%2Bjson/schema"
}
}
}
}
}
}
},
"/follow-lists/{follow_list_id}/subscriptions/businesses": {
"get": {
"tags": [
"Business Subscriptions"
],
"parameters": [
{
"name": "follow_list_id",
"in": "path",
"required": true,
"description": "The ID of the Follow List where a Subscription will be created.",
"schema": {
"$ref": "#/components/schemas/ID"
}
},
{
"name": "page",
"in": "query",
"style": "deepObject",
"description": "`size`defines the number of records to return in each page. default value: 10, maximum value: 20.
`cursor`specifies the next page cursor.",
"schema": {
"$ref": "#/components/schemas/Page"
}
},
{
"name": "status",
"schema": {
"type": "string",
"enum": [
"open",
"closed"
]
},
"in": "query",
"required": false,
"description": "Filters Subscriptions by status. If not present, all Subscriptions are returned."
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ListOfPersonSubscriptions"
},
"example": {
"data": [
{
"type": "subscriptions",
"id": "01H2TC48NQGJ1RXJBQC3GR72QC",
"attributes": {
"countries": [
"US"
],
"createdDateTimeISO": "2023-05-10T11:24:12.515Z",
"discardedCount": 0,
"falsePositiveCount": 0,
"lastUpdatedDateTimeISO": "2023-05-10T14:35:48.019Z",
"name": "BMI Corporation",
"id": "ABC123",
"openCount": 0,
"truePositiveCount": 0
},
"links": {
"self": "https://example.com/follow-lists/01H3T8GTDTYBFDSE99N7QZ9KK8/subscriptions/businesses/01H2TC48NQGJ1RXJBQC3GR72QC"
}
}
],
"links": {
"next": "https://example.com/follow-lists/01H3T8GTDTYBFDSE99N7QZ9KK8/subscriptions/businesses?page[cursor]=eyJnc2kxaGFQ0dHUjdUUVYifQ==&page[size]=1",
"self": "https://example.com/follow-lists/01H3T8GTDTYBFDSE99N7QZ9KK8/subscriptions/businesses?page[size]=1"
},
"meta": {
"discardedAlertsCount": 0,
"falsePositiveAlertsCount": 0,
"openAlertsCount": 0,
"openSubscriptionsCount": 0,
"subscriptionsCount": 2,
"truePositiveAlertsCount": 0
}
}
}
},
"headers": {
"X-Correlation-Id": {
"schema": {
"type": "string",
"format": "uuid",
"description": "Unique request identifier"
}
},
"X-Ratelimit-Limit": {
"schema": {
"type": "integer",
"description": "The number of request available in a rate limit window"
}
},
"X-Ratelimit-Remaining": {
"schema": {
"type": "integer",
"description": "The number of requests left for the rate limit window"
}
},
"X-Ratelimit-Reset": {
"schema": {
"type": "integer",
"description": "The Unix timestamp at which the current rate limit window resets"
}
}
}
},
"400": {
"$ref": "#/paths/~1follow-lists/get/responses/400"
},
"401": {
"$ref": "#/paths/~1follow-lists/get/responses/401"
},
"403": {
"$ref": "#/paths/~1follow-lists/get/responses/403"
},
"404": {
"$ref": "#/paths/~1follow-lists/get/responses/404"
},
"500": {
"$ref": "#/paths/~1follow-lists/get/responses/500"
}
}
}
}
},
"components": {
"securitySchemes": {
"ApiKeyAuth": {
"type": "apiKey",
"in": "header",
"name": "X-API-KEY"
}
},
"schemas": {
"ListOfFollowList": {
"title": "List of Follow Lists",
"description": "Paginated response with list of Follow Lists",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FollowListObject"
}
},
"links": {
"type": "object",
"properties": {
"next": {
"title": "JSON:API Link",
"description": "A JSON:API link can be either a URL string or a structured link object.",
"oneOf": [
{
"type": "string",
"format": "url",
"example": "https://example.com/"
},
{
"title": "JSON:API Link Object",
"description": "a structured representation of a URL",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"example": "/organizations/"
},
"meta": {
"type": "object",
"example": {
"count": "10"
}
}
}
}
]
},
"self": {
"$ref": "#/components/schemas/ListOfFollowList/properties/links/properties/next"
}
}
}
}
},
"ListOfPersonSubscriptions": {
"title": "List of Person Subscriptions",
"description": "Paginated response with list of Person Subscriptions",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FullPersonSubscriptionObject"
}
},
"links": {
"type": "object",
"properties": {
"next": {
"$ref": "#/components/schemas/ListOfFollowList/properties/links/properties/next"
},
"self": {
"$ref": "#/components/schemas/ListOfFollowList/properties/links/properties/next"
}
}
},
"meta": {
"$ref": "#/components/schemas/SubscriptionStatistics"
}
}
},
"FullPersonSubscriptionObject": {
"title": "Person Subscription object",
"description": "a Person Subscription object structure",
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/ID"
},
"type": {
"type": "string",
"example": "subscriptions"
},
"attributes": {
"allOf": [
{
"$ref": "#/components/schemas/BaseSubscription"
},
{
"$ref": "#/components/schemas/BasePersonSubscription"
}
]
},
"links": {
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/ListOfFollowList/properties/links/properties/next"
}
}
}
}
},
"SubscriptionStatistics": {
"type": "object",
"required": [
"subscriptionsCount",
"openSubscriptionsCount",
"openAlertsCount",
"falsePositiveAlertsCount",
"truePositiveAlertsCount",
"discardedAlertsCount"
],
"properties": {
"subscriptionsCount": {
"type": "integer",
"example": 5,
"description": "The number of subscriptions in the given Follow List."
},
"openSubscriptionsCount": {
"type": "integer",
"example": 1,
"description": "The number of open subscriptions in the given Follow List."
},
"openAlertsCount": {
"type": "integer",
"example": 3,
"description": "The number of open Alerts (matching profiles) in all subscriptions in the given Follow List."
},
"falsePositiveAlertsCount": {
"type": "integer",
"example": 3,
"description": "The number of false-positive Alerts (matching profiles) in all subscriptions in the given Follow List."
},
"truePositiveAlertsCount": {
"type": "integer",
"example": 1,
"description": "The number of true-positive Alerts (matching profiles) in all subscriptions in the given Follow List."
},
"discardedAlertsCount": {
"type": "integer",
"example": 1,
"description": "The number of discarded Alerts (matching profiles) in all subscriptions in the given Follow List."
}
}
},
"BasePersonSubscription": {
"type": "object",
"required": [
"name",
"countries"
],
"properties": {
"name": {
"description": "The full name of the person you want to monitor.",
"minLength": 1,
"maxLength": 200,
"type": "string",
"example": "Jane Doe"
},
"countries": {
"type": "array",
"example": [
"US"
],
"minItems": 0,
"items": {
"type": "string"
},
"description": "The list of countries from the addresses and nationalities of the profile."
},
"dateOfBirth": {
"type": "string",
"example": "1991-07-22",
"description": "Date in either YYYY-MM-DD or YYYY ISO format."
},
"gender": {
"description": "The gender of the person.",
"type": "string",
"example": "female",
"enum": [
"male",
"female"
]
}
}
},
"Page": {
"type": "object",
"properties": {
"size": {
"type": "integer",
"default": 10,
"description": "The number of records to return in each page."
},
"cursor": {
"type": "string",
"example": "CEcTEwIRUV9RDw==",
"description": "Leaving this blank will return the first page. Otherwise you can provide the cursor from a previous request to iterate to the next page."
}
}
},
"ID": {
"title": "ID of a resource.",
"type": "string"
},
"BaseSubscription": {
"type": "object",
"required": [
"openCount",
"falsePositiveCount",
"truePositiveCount",
"discardedCount",
"createdDateTimeISO",
"lastUpdatedDateTimeISO"
],
"properties": {
"openCount": {
"type": "integer",
"example": 1,
"description": "The number of open Alerts for the Subscription."
},
"falsePositiveCount": {
"type": "integer",
"example": 0,
"description": "The number of Alerts already closed as false positive."
},
"truePositiveCount": {
"type": "integer",
"example": 0,
"description": "The number of Alerts already closed as true positive."
},
"discardedCount": {
"type": "integer",
"example": 0,
"description": "The number of Alerts already discarded."
},
"createdDateTimeISO": {
"type": "string",
"example": "2021-10-05T10:10:08.270Z",
"description": "The timestamp that the record was first created."
},
"lastUpdatedDateTimeISO": {
"type": "string",
"example": "2021-10-05T10:10:08.270Z",
"description": "The last time the record was updated by the user."
}
}
}
}
}
}
```