Skip to main content
Salfio Docs

Search documentation

Type to search this documentation.

On this pageOverview

List a client's assignment rules

Returns one entry per active integration in the organization, each carrying that integration's current rule for this client. When an integration has no rule configured for the client yet, the entry is still returned with `ruleId: null` — so this doubles as a way to discover the `integrationId`s you can bind. Cross-tenant lookups and missing clients both return `404 not_found` so existence is never leaked.

GET

/clients/{clientId}/assignment-rules

bearerAuth``

AuthorizationBearer <token>

Salfio API tokens start with the literal prefix sk_live_ followed by 32 base62 characters (≈190 bits of entropy). Tokens are hashed at rest with argon2id and shown to the user only once at creation.

In: header

clientId*string

Client UUID.

Formatuuid

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.salfio.com/v1/clients/497f6eca-6276-4993-bfeb-53cbbbba6f08/assignment-rules"

{
  "meta": {
    "cursor": "string",
    "hasMore": true
  },
  "data": [
    {
      "ruleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac",
      "integrationId": "497a18ca-284e-40c0-985d-f72be35d468e",
      "integrationType": "slack",
      "providerEmail": "string",
      "filterCriteria": null,
      "enabled": true,
      "priority": 0,
      "readOnly": true,
      "rulesHidden": true,
      "chatLabels": {
        "property1": "string",
        "property2": "string"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

{
  "error": {
    "code": "invalid_argument",
    "message": "limit must be an integer between 1 and 100"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "client not found"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded",
    "details": {
      "retry_after_seconds": 30
    }
  }
}
Export
Suggest an edit to this page

Documentation menu