Skip to content
campaiDeveloper
campai.com

Search

POST/{organizationId}/{mandateId}/searchReads only

Search records

Finds records of the organization by a text, typos included: contacts, receipts, events, products, groups, mailings, and Drive folders and files. Returns up to the limit per type, best match first, and only records the caller may read.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Permission checks in detail
Required permissions
  • mandate.read
Also checked, depending on the request and the records it touches
  • user.read
  • apiKey.read
  • contact:member.read
  • contact:address.read
  • contact:customer.read
  • contact:sponsor.read
  • contact:contributor.read
  • contact:employee.read
  • contact:supplier.read
  • contact.read

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Body

Content-Type: application/json

  • searchTermstringrequired

    1–200 characters

  • typesstring[]

    at least 1 items

    contact receipt event product group mailing driveFolder driveFile
  • limitinteger

    1–20 · default 5

  • filtersobject[]

    at most 5 items · default []

    2 properties
    • fieldstringrequired

      1–40 characters

    • valuesstring[]required

      1–20 items · each at most 100 characters

Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/search' \
  --header 'X-API-Key: YOUR_API_KEY'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

Content-Type: application/json

  • recordsobject[]
    7 properties
    • typestring
      contact receipt event product group mailing driveFolder driveFile
    • idid
    • titlestring
    • detailstring
    • paramsobject of string
    • relatedobject of string
    • actorobjectnullable
      7 properties
      • namestring
      • typestring
      • nameNormalizedstring
      • nameSortstring
      • contactidnullable
      • imageobjectnullable
        4 properties
        • resourcestring

          at least 1 characters

        • fileNamestring

          at most 128 characters

        • contentTypestring

          at most 75 characters

        • fileSizeBytesinteger

          at least 0

      • userobjectnullable
        4 properties
        • namestring
        • typestring
        • userIdstring
        • imageobjectnullable
          4 properties
          • resourcestring

            at least 1 characters

          • fileNamestring

            at most 128 characters

          • contentTypestring

            at most 75 characters

          • fileSizeBytesinteger

            at least 0

Response200
{
  "records": [
    {
      "type": "contact",
      "id": "000000000000000000000001",
      "title": "string",
      "detail": "string",
      "params": {
        "key": "string"
      },
      "related": {
        "key": "string"
      },
      "actor": {
        "name": "string",
        "type": "contact",
        "nameNormalized": "string",
        "nameSort": "string",
        "contact": "000000000000000000000001",
        "image": {
          "resource": "string"
        },
        "user": {
          "name": "string",
          "type": "user",
          "userId": "string",
          "image": {
            "resource": "string"
          }
        }
      }
    }
  ]
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.