Family Finding Searches

A record of a Family Finding Search.

• id* (string) - The primary key for the record.
• type* (string) - The JSON:API type specifier.
• attributes* (object) - Primary record attributes.
  • created-at* (string) - Datetime Family Finding Search was created.
  • updated-at* (string) - Datetime Family Finding Search was last updated in Binti.
  • end-date* (string) - Date the Family Finding Search was ended.
  • related-attributes* (object) - Properties of related objects. 'child-' properties correspond to the Child record connected to this Family Finding Search
    • child-client-id* (string) - Identifier used in external system that can be used to match a singular child in Binti with a child record in another system. Must be unique for each child at an agency.
  • start-date* (string) - Date the Family Finding Search was started.
• relationships (object) - Related objects. For each relationship, you can find detailed information about the object by issuing another API call to look it up by ID, or for certain endpoints, you will find details in the "included" section.
  • child (object) - A relationship with a single entry.
    • data* (object) - A reference to the child if a person is a child

      • id* (string) - The ID of the other object.

      • type* (string) - Always children

        Allowed values

        • children
  • agency-workers (object) - A relationship with multiple entries.
    • data* (array) - Array of entries.

      • id* (string) - The ID of the other object.

      • type* (string) - Always agency-workers

        Allowed values

        • agency-workers