Skip to main content
GET
/
partners
List partners
curl --request GET \
  --url https://api.agentic.scope3.com/api/v2/partner/partners \
  --header 'Authorization: Bearer <token>'
{
  "partners": [
    {
      "id": "12345",
      "name": "Acme Activation",
      "status": "ACTIVE",
      "createdAt": "2025-01-15T10:30:00Z",
      "updatedAt": "2025-01-20T14:45:00Z",
      "description": "Activation partner for Acme Corporation"
    }
  ],
  "total": 10
}

Authorizations

​
Authorization
string
header
required

API key or access token

Query Parameters

​
status
enum<string>
default:ACTIVE

Filter by partner status (defaults to ACTIVE)

Available options:
ACTIVE,
ARCHIVED
​
name
string

Filter by partner name (case-insensitive, partial match)

Example:

"Acme"

​
take
integer
default:50

Number of results to return (max 250)

Required range: x <= 250
Example:

50

​
skip
integer
default:0

Number of results to skip for pagination

Required range: 0 <= x <= 9007199254740991
Example:

0

Response

List partners

Response containing a paginated list of partners

​
partners
object[]
required

List of partners

​
total
integer
required

Total count of partners matching the query

Required range: 0 <= x <= 9007199254740991
Example:

10