List Squads

GET

Headers

Auth
AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

limitdoubleOptional

This is the maximum number of items to return. Defaults to 100.

createdAtGtdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

This will return items where the createdAt is greater than the specified value.

createdAtLtdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

This will return items where the createdAt is less than the specified value.

createdAtGedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

This will return items where the createdAt is greater than or equal to the specified value.

createdAtLedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

This will return items where the createdAt is less than or equal to the specified value.

updatedAtGtdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

This will return items where the updatedAt is greater than the specified value.

updatedAtLtdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

This will return items where the updatedAt is less than the specified value.

updatedAtGedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

This will return items where the updatedAt is greater than or equal to the specified value.

updatedAtLedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

This will return items where the updatedAt is less than or equal to the specified value.

Response

memberslist of objects

This is the list of assistants that make up the squad.

The call will start with the first assistant in the list.

idstring

This is the unique identifier for the squad.

orgIdstring

This is the unique identifier for the org that this squad belongs to.

createdAtdatetime

This is the ISO 8601 date-time string of when the squad was created.

updatedAtdatetime

This is the ISO 8601 date-time string of when the squad was last updated.

namestringOptional

This is the name of the squad.

membersOverridesobjectOptional

This can be used to override all the assistants’ settings and provide values for their template variables.

Both membersOverrides and members[n].assistantOverrides can be used together. First, members[n].assistantOverrides is applied. Then, membersOverrides is applied as a global override.

Create Squad
Built with