OCT-103 Gumlet outreach
GET/video/profiles

List video profiles

Lists video profiles that have already been created. Use offset and size to retrieve the profile list in pages, passing the returned current_offset when requesting the next page. The response includes the profiles and the total profile count.

2 parameters
offsetintegeroptional

Offset for the paginated profile list. Use 0 for the first request and the returned current_offset for subsequent requests.

sizeintegeroptional

Number of profiles to return per page. Defaults to 10 when omitted.

3 status codes
200Returns an object containing the profile list, the current offset, and the total profile count.
all_profilesarray<object>optional
current_offsetintegeroptional
Default:0
total_profile_countintegeroptional
Default:0
401Returned when the API key or bearer token is missing or invalid.

One documented failure

  • invalid_api_key

    API key supplied with request is invalid

errorobjectrequired
403Returned when the account is unpaid or the authenticated user has insufficient role permissions.

One documented failure

  • unauthorized

    You don't have access to this feature. Please contact your organization owner.

errorobjectrequired

Error handling

A 401 indicates a missing or invalid API key or bearer token, and a 403 indicates an unpaid account or insufficient role permissions. Use offset as 0 for the first page and then pass the returned current_offset; size controls the page size and defaults to 10.