FamilyService

ListFamilyAlignments

Lists all alignments for a specific family version.

get/api/v1/families/versions/{familyVersionId}/alignments

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v1/families/versions/{familyVersionId}/alignments
  • Auth: HTTP bearer

Path parameters

familyVersionIdstring required

Provide family_id to identify the family to list alignments.

Query parameters

pageSizeinteger

The maximum number of family version alignments to return. The service may return fewer than this value, even if there are additional pages. If unspecified, the limit defaults to 200. The maximum value is 1000.

filterstring

A Common Expression Language (CEL) filter string. Available fields to filter by are: name, description. For further information about how to use CELs, please refer to this guide.

pageTokenstring

A page token, received from a previous ListFamilyAlignments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListFamilyAlignments must match the call that provided the page token.

Response

A successful response.

nextPageTokenstring

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Changes

No recorded changes to this operation across all 1 revision of this API.