Search – Baack docs
Search
Representation of a search and it's results when available
Browse the docs
Endpoints
GET/n/v1/search/{urn}
Search endpoint with support for locating collections of different types.
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/search/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| urn | string (uuid) | |
| owner | Company | Required on create. |
| pagination | Pagination | |
| createdTimestamp | string (date-time) | |
| updatedTimestamp | string (date-time) | |
| items | array of Search Item | Ignored on update. |
| includeScopes | string | Ignored on update. One of: |
| url | string (uri) | |
| status | string | One of: |
| order | string | Optional. |
Search Item
A search result item
Fields
| Field | Type | Description |
|---|---|---|
| urn | string (uuid) | |
| item | one of Entity, Entity List, Group, Group Membership, Identity, Project, Task | |
| sortOrder | integer (int32) | |
| name | string | |
| type | string | One of: |
| url | string (uri) |
Used by: Search