SAsalesforce
profiles

Find profiles

Changed on

Find a profile or profiles. You may query using field filters with asterisk (*) wildcards. You may also optionally specify sort, limit, offset, and a list of fields to include in the response. The global default limit will apply if no limit param is specified.

get/profiles

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/profiles
  • Auth
    API key in header Authorization

Query parameters

fieldsstring[]

Comma-delimited list of field names to include in the response.

sortstring[]

Specify the sort order using a field name, e.g. '...?sort=name'. Prepend the field name with a minus sign to specify descending order, e.g. '...?sort=-name'.

limitinteger

Maximum number of records to return in the response; also useful for pagination in the UI.

offsetinteger

Offset for paginating the response.

createdAtstring

Filter by time period when profiles were created.

updatedAtstring

Filter by time period when profiles were updated.

Response

Success, returns a list of profiles.

idstring
namestring

The name of the profile.

aspectAccess'r' | 'rw'

The permission to read and/or write aspects.

botAccess'r' | 'rw'

The permission to read and/or write bots.

eventAccess'r' | 'rw'

The permission to read and/or write events.

lensAccess'r' | 'rw'

The permission to read and/or write lenses.

perspectiveAccess'r' | 'rw'

The permission to read and/or write perspectives.

profileAccess'r' | 'rw'

The permission to read and/or write profiles.

roomAccess'r' | 'rw'

The permission to read and/or write rooms.

roomTypeAccess'r' | 'rw'

The permission to read and/or write roomTypes.

sampleAccess'r' | 'rw'

The permission to read and/or write samples.

subjectAccess'r' | 'rw'

The permission to read and/or write subjects.

userAccess'r' | 'rw'

The permission to read and/or write users.

createdBystring

TODO

createdAtstring

TODO

updatedAtstring

TODO

Changes

  • v161c43b67559bRevision changes
    • info

      added the new optional query request parameter createdAt

    • info

      added the new optional query request parameter updatedAt