Query parameters

• department array[string]

  One or more departments to filter clients by. This is the org.departments[]._id value.

• emailDomain array[string]

  One or more email domains to filter clients by.

• id array[string]

  One or more IDs to filter the response by. Compares against the document's _id value.

• archived boolean | number

  If true, only archived documents will be returned. Defaults to false. If you need both archived and non-archived, use withArchived instead.

  Values are false, true, 0, or 1.

• withArchived boolean | number

  If true, both archived and non-archived documents will be returned. Defaults to false.

  Values are false, true, 0, or 1.

• updatedAt string

  A date query to filter the results by the last updatedAt value. Format is updatedAt=<operator> <date>, e.g. updatedAt=gt 2025-02-24T00:00:00.000Z. Acceptable operations are lt = lower than, lte = lower than or equal, gt = greater than, gte = greater than or equal, eq = equal. The date is in ISOString.

• select array[string]

  One or more properties to be included in the response, instead of the full payload. E.g. select=endDate,projectStatus. You can also exclude fields by prefixing with a minus sign, e.g. select=-endDate,-projectStatus, but you cannot mix both.

• sortBy string

  Optionally, the field to sort the results by. By default, results are sorted by created date. Only updatedAt is supported at this moment (Note: updatedAt equals to createdAt for documents that have never been updated).

  Value is updatedAt.

• sortDirection string

  Optionally, the direction to sort the documents by. For ascending (oldest first) use either 1 or asc. By default sorting is descending (latest first), -1 or desc.

  Values are 1, asc, -1, or desc.

• limit integer

  Optionally, change the default document response limit of 40.

  Minimum value is 1, maximum value is 100. Default value is 40.

Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

  • value array[object]
    Hide value attributes Show value attributes object

    • _id string(ObjectId)

      The unique document ID.

    • customId string

      A custom identifier for internal reference by your system (not used by missionX).

    • title string

      The name of the client.

    • emailDomains array[string]

      The last part (after the @) of any client emails you might want to give access to projects. E.g. missionx.ai

    • departments array[string]

      One or more department IDs associated with this client, i.e. org.departments[]._id

  • nextLink string

    The full URL to be used in order to fetch the next page of results. If not defined, it means there are no more pages.

    Note: The documents are not being counted to know when all documents have been exhausted, we simply check if the length of the paginated list is less than the paginated limit. This means that if by coincidence the last paginated document list has the same length as the paginated limit, nextLink will be defined and will result in an empty list of documents.