API v3 is live and in beta: expect possible malfunctions and breaking changes in the coming days. If you find a bug, please report it to your Sillage contact.

Partner API

Manage your clients' workspaces with the Sillage Partner API.

The Partner API lets your application work on the workspaces of your clients. Every integration starts by creating a workspace: the partner_workspace_id you choose is your own ID for the client. It is 1 to 255 characters long, with no /, ?, # or whitespace; a malformed ID is refused with 422 and errors.partner_workspace_id. Every other route names the client it works on with partner_workspace_id in its path, and answers as the same route of the direct API would for that workspace, apart from the exceptions each page names (for example usage).

Base URL

https://api.getsillage.com

OpenAPI specification: Swagger UI · Raw JSON spec. See also OpenAPI specification.

Authentication

Send your partner master key as a bearer token:

Authorization: Bearer <YOUR_MASTER_KEY>

Master keys start with mk_live_ and let you act on every workspace you manage. See Authentication for the error model and the response headers.

Start here: create a workspace

Create one workspace per client, then use its partner_workspace_id in every other path:

curl -X POST "https://api.getsillage.com/api/v3/partner/workspaces" \
  -H "Authorization: Bearer $SILLAGE_MASTER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"partner_workspace_id": "crm-4821", "name": "Acme", "domain": "acme.com", "owner_email": "owner@acme.com"}'

See Create a client workspace.

References

Every endpoint of the API, by family.

Workspaces

Create and manage your clients' workspaces.

POSTCreate a client workspace/api/v3/partner/workspacesGETList your client workspaces/api/v3/partner/workspacesGETGet a client workspace/api/v3/partner/workspaces/{partner_workspace_id}PATCHUpdate a client workspace/api/v3/partner/workspaces/{partner_workspace_id}DELETEDelete a client workspace/api/v3/partner/workspaces/{partner_workspace_id}POSTRestore a deleted client workspace/api/v3/partner/workspaces/{partner_workspace_id}/restore

Signal templates

The signals you can set up.

GETList a client's signal templates

/api/v3/partner/workspaces/{partner_workspace_id}/signal-templates

GETGet a client's signal template

/api/v3/partner/workspaces/{partner_workspace_id}/signal-templates/{signal_template_id}

Signal setups

The signals the client runs.

POSTCreate a signal setup

/api/v3/partner/workspaces/{partner_workspace_id}/signal-setups

GETList a client's signal setups

/api/v3/partner/workspaces/{partner_workspace_id}/signal-setups

GETGet a client's signal setup

/api/v3/partner/workspaces/{partner_workspace_id}/signal-setups/{signal_setup_id}

PATCHUpdate a client's signal setup

/api/v3/partner/workspaces/{partner_workspace_id}/signal-setups/{signal_setup_id}

DELETEDelete a client's signal setup

/api/v3/partner/workspaces/{partner_workspace_id}/signal-setups/{signal_setup_id}

Signals

The signals detected for the client.

POSTQuery signals

/api/v3/partner/workspaces/{partner_workspace_id}/signals/query

POSTCount signals

/api/v3/partner/workspaces/{partner_workspace_id}/signals/count

GETGet a signal

/api/v3/partner/workspaces/{partner_workspace_id}/signals/{signal_id}

DELETEDelete a signal

/api/v3/partner/workspaces/{partner_workspace_id}/signals/{signal_id}

Signal runs

Start a signal and follow it.

GETList signal runs

/api/v3/partner/workspaces/{partner_workspace_id}/signal-runs

POSTLaunch signal runs

/api/v3/partner/workspaces/{partner_workspace_id}/signal-runs

GETGet a client's signal run

/api/v3/partner/workspaces/{partner_workspace_id}/signal-runs/{signal_run_id}

Request status

Everything that is running now.

GETGet requests status

/api/v3/partner/workspaces/{partner_workspace_id}/requests-status

Lists

Lists of companies or people that signals watch.

POSTCreate a list for a client/api/v3/partner/workspaces/{partner_workspace_id}/listsGETList the lists of a client/api/v3/partner/workspaces/{partner_workspace_id}/listsGETGet a list

/api/v3/partner/workspaces/{partner_workspace_id}/lists/{kind}/{list_id}

PATCHUpdate a list

/api/v3/partner/workspaces/{partner_workspace_id}/lists/{kind}/{list_id}

DELETEDelete a list

/api/v3/partner/workspaces/{partner_workspace_id}/lists/{kind}/{list_id}

POSTRestore a list

/api/v3/partner/workspaces/{partner_workspace_id}/lists/{kind}/{list_id}/restore

GETList membership log

/api/v3/partner/workspaces/{partner_workspace_id}/lists/{kind}/{list_id}/membership-logs

GETList members

/api/v3/partner/workspaces/{partner_workspace_id}/lists/{kind}/{list_id}/members

POSTAdd members

/api/v3/partner/workspaces/{partner_workspace_id}/lists/{kind}/{list_id}/members

DELETERemove a member

/api/v3/partner/workspaces/{partner_workspace_id}/lists/{kind}/{list_id}/members/{member_id}

Account monitoring

Choose which accounts are monitored.

GETGet the monitoring summary

/api/v3/partner/workspaces/{partner_workspace_id}/account-monitoring

PUTMonitor or stop accounts

/api/v3/partner/workspaces/{partner_workspace_id}/account-monitoring/accounts

Leads

The people the client's signals found.

POSTQuery leads

/api/v3/partner/workspaces/{partner_workspace_id}/leads/query

POSTCount leads

/api/v3/partner/workspaces/{partner_workspace_id}/leads/count

GETGet a lead

/api/v3/partner/workspaces/{partner_workspace_id}/leads/{lead_id}

PATCHUpdate a client's lead

/api/v3/partner/workspaces/{partner_workspace_id}/leads/{lead_id}

Companies

The companies of the client's workspace.

POSTSearch companies

/api/v3/partner/workspaces/{partner_workspace_id}/companies/query

GETGet a company

/api/v3/partner/workspaces/{partner_workspace_id}/companies/{company_id}

Account mapping

The people mapped on each account.

GETList a client's company mappings

/api/v3/partner/workspaces/{partner_workspace_id}/company-mappings

GETGet a client's company mapping

/api/v3/partner/workspaces/{partner_workspace_id}/company-mappings/{mapping_id}

Personas

The profiles of the people the client targets.

GETList personas/api/v3/partner/workspaces/{partner_workspace_id}/personasPOSTCreate a persona/api/v3/partner/workspaces/{partner_workspace_id}/personasGETGet a persona

/api/v3/partner/workspaces/{partner_workspace_id}/personas/{persona_id}

PATCHUpdate a persona

/api/v3/partner/workspaces/{partner_workspace_id}/personas/{persona_id}

Setup state

What is still missing to get started.

GETGet the setup state

/api/v3/partner/workspaces/{partner_workspace_id}/setup-state

Contents

The content collected for key accounts.

POSTQuery contents

/api/v3/partner/workspaces/{partner_workspace_id}/contents/query

GETGet a content item

/api/v3/partner/workspaces/{partner_workspace_id}/contents/{content_id}

Content requests

The requests that gather content and map accounts.

POSTQuery content requests

/api/v3/partner/workspaces/{partner_workspace_id}/content-requests/query

GETGet a content request

/api/v3/partner/workspaces/{partner_workspace_id}/content-requests/{content_request_id}

Usage

What you are billed for each client.

GETList usage/api/v3/partner/workspaces/{partner_workspace_id}/usage

How the routes are named

  • GET reads one item by its ID, or a plain list with few filters.
  • POST .../query searches with filters that take lists of values, such as several domains or several types. The filters travel in a JSON body.
  • POST .../count counts what a search would match.
  • PATCH, PUT and DELETE change or remove an item.

A route that takes a body (POST, PATCH or PUT) needs a JSON body, even when every field is optional: send {}. A missing or empty body is refused with 422 and the code body_required. The restore routes take no body.

Identifiers

All identifiers are integers, except partner_workspace_id, which is a string.

Dates

Date filters take an ISO 8601 date and time with a UTC offset, for example 2026-06-12T10:30:00Z. Responses return dates in UTC.

Lists in query strings and bodies

A query parameter that takes a list accepts a comma list (?company_ids=1,2) or the key repeated (?company_ids=1&company_ids=2); repeating a parameter that takes one value is refused with 422. A body sent with GET or DELETE is ignored.

Pagination

Searches and usage page by cursor, plain lists page by page number. See Pagination.

Errors

Every error is an RFC 9457 problem document with a stable code, and input the API does not know is refused with 422. See Authentication.

Authentication

Authenticate partner requests with a partner master key.

On this page

Base URLAuthenticationStart here: create a workspaceReferencesWorkspacesSignal templatesSignal setupsSignalsSignal runsRequest statusListsAccount monitoringLeadsCompaniesAccount mappingPersonasSetup stateContentsContent requestsUsageHow the routes are namedIdentifiersDatesLists in query strings and bodiesPaginationErrors