Skip to main content
GET
Get Introduction Paths

Authorizations

Authorization
string
header
required

A static Affinity API key, presented as a bearer token.

Query Parameters

filter
string
required

Filter options. Required; must contain exactly one of the target.id or target.currentCompany.id filter terms. See the Filters section above.

cursor
string

Cursor for the next or previous page.

limit
integer<int32>
default:20

Number of items to include in the page.

Required range: 1 <= x <= 100
totalCount
boolean
default:false

Include total count of the collection in the pagination response.

Response

OK

A paginated list of introduction paths.

data
IntroPath · object[]
required

A page of IntroPath objects, ordered by rank, strongest first.

Maximum array length: 100
pagination
PaginationWithTotalCount · object
required