List keyword sets

get

https://uapi.demandbase.com/data/intent/v1/keyword-sets

Returns one page of keyword-set metadata for your tenant, optionally filtered, sorted and
paginated.

List items never include keywords or seedUrls. Read those through the
/keyword-sets/{keywordSetId}/keywords and /keyword-sets/{keywordSetId}/seed-urls
subresources, each of which paginates independently.

This is also how a single keyword set's metadata is read: GET /keyword-sets?id=9427.
There is no standalone GET /keyword-sets/{keywordSetId} endpoint.

Filtering behaviour differs between the two filters by design. An id that does not exist,
or belongs to another tenant, returns 404-106 rather than an empty page, so identifiers
cannot be enumerated across tenants. A name that matches nothing returns 200 with an
empty keywordSets array, because a search finding nothing is a valid result. When both are
supplied, id takes precedence and name is not applied.

A page beyond the last page returns 200 with an empty keywordSets array.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

int64

≥ 1

Exact keyword-set identifier. Returns a single-item page on a match, 404-106
otherwise. Takes precedence over name.

name

string

Case-insensitive partial match on the keyword-set name.

sortBy

string

enum

Defaults to createdAt

Field to sort by. Case-sensitive; anything outside the listed values is rejected with
400-237.

Allowed:

sortOrder

string

enum

Defaults to DESC

Sort direction. Case-insensitive, so asc and ASC are equivalent.

Allowed:

page

integer

≥ 1

Defaults to 1

Page number, 1-based. Reported back as pageNo. An explicitly empty value is treated as
absent, so the default applies.

perPage

integer

1 to 500

Defaults to 25

Number of results per page. Reported back as pageSize. An explicitly empty value is
treated as absent, so the default applies.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

429

Too many requests. Reduce concurrency and retry with exponential backoff and jitter. This
response is generated before the request reaches the Intent API, so its body does not use
the Demandbase error envelope.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200One page of keyword-set metadata.

400A query parameter failed validation. When a request has more than one problem, only one error is returned — fix it and resend to see the next.

401Authentication failed, or the token carries no API permissions.

403The token is valid but lacks the INTENT_API_FULL_ACCESS permission these endpoints require.

404The keyword set does not exist, or belongs to another tenant. The two are reported identically so that identifiers cannot be enumerated across tenants.

500An unexpected error occurred. For a write, the change may or may not have been applied, so re-read the keyword set before retrying.

502An upstream service returned an error or an unexpected response. Retry with backoff.

503The service is temporarily unavailable. Retry with backoff.

504The request timed out. A write may still have been applied — re-read the resource before retrying. Requests that add seed URLs are allowed appreciably longer than others, because keyword generation runs synchronously.