1. Partner API v2
  2. Resources
  3. Partner

Partner

Your partner account, its admins, and the key you are calling with.
3 endpointsScope readPartnerAdminApiKeyInfo
GET/v2/partner

Get your partner accountLink to this endpoint

RequiresreadscopeReturns Partner

The partner organization that owns the API key.

No parameters. Send the request with your API key.

curl "https://app.infimasecapis.com/v2/partner" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPartner
idstring
namestring
created_atstring (date-time)
client_countinteger
featuresobject
Show properties(1)
dark_web_monitoringboolean
Errors401Missing or invalid API keyError envelope →
GET/v2/partner/admins

List partner adminsLink to this endpoint

RequiresreadscopeCursor-paginatedReturns Page of Admin

Dashboard admins on the partner account. Client-scoped admins appear under the client instead. Requires a key with access to all clients.

Query parametersall optional unless marked

limitinteger

Default 100min 1 · max 500

cursorstring

Opaque cursor from the previous page's page.next_cursor.

curl "https://app.infimasecapis.com/v2/partner/admins" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of Admin
dataarray of Admin
Show item properties(8)
idstring
emailstring (email)
namestring
rolestring
One ofowneradminviewer
scopestring

Partner admins see every client; client admins see one.

One ofpartnerclient
client_idstringNullable

Set when scope is client.

last_login_atstring (date-time)Nullable
created_atstring (date-time)
pageobject
Show properties(2)
next_cursorstringNullable

Pass as cursor to fetch the next page. Null on the last page.

has_moreboolean
Errors403The key cannot perform this action or reach this clientError envelope →
GET/v2/partner/api-key

Describe the calling keyLink to this endpoint

RequiresreadscopeReturns ApiKeyInfo

Returns the title, scopes, and client access of the key used to make this request. Use it to verify a key before wiring it into tooling, or to let an assistant discover what it is allowed to do.

No parameters. Send the request with your API key.

curl "https://app.infimasecapis.com/v2/partner/api-key" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectApiKeyInfo
idstring
titlestring
prefixstring
scopesarray of string
Each one ofreadwrite
accessobject
Show properties(2)
all_clientsboolean
client_idsarray of string

Populated when all_clients is false.

created_atstring (date-time)
last_used_atstring (date-time)Nullable