Skip to main content
GET
/
advancedjoins
/
matches
List matches
curl --request GET \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins/matches \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "externalId": "my.known.id",
      "advancedJoinExternalId": "my.known.id",
      "originExternalId": "my.known.id",
      "linkedExternalId": "my.known.id"
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Query Parameters

​
limit
integer
default:100

Limits the number of results to be returned. The maximum results returned by the server is 1000 even if you specify a higher limit.

Required range: 1 <= x <= 1000
​
cursor
string

Cursor for paging through results. In general, if a response contains a nextCursor property, it means that there may be more results, and you should pass that value as the cursor parameter in the next request.

Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.

Example:

"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"

​
advancedJoinExternalId
string

The external ID provided by the client. Must be unique for the resource type.

Maximum string length: 255
Example:

"my.known.id"

Response

A list of matches, and possibly a cursor for fetching the next page of matches.

​
items
object[]
required
Required array length: 1 - 1000 elements
​
nextCursor
string

A cursor that can be passed to this endpoint to get the next page of items.

Last modified on April 23, 2026