Provider Members

A Provider Member is a link between a Placement Provider and a User Agency Profile, containing information specific to that person's role and duration at the provider.

  • id* (string) - The primary key for the record.
  • type* (string) - The JSON:API type specifier.
  • attributes* (object) - Primary record attributes.
    • primary* (boolean) - Boolean flag designating the member as the "primary" caregiver in this Placement Provider.

    • role* (string) - The role this member fills in the given Placement Provider.

      Allowed values
      • caregiver
      • child_in_home
      • other_adult_in_home
      • staff_member
    • subrole* (string) - The member's subrole in the given Placement Provider.

    • subrole-details* (string) - Details regarding the member's subrole in the given Placement Provider.

    • joined-at* (string) - Date the Member joined the Placement Provider.

    • created-at* (string) - Date the Member was created in Binti.

    • updated-at* (string) - Date the Member was last updated at in Binti.

    • left-at* (string) - Date the Member departed the Placement Provider. Not set for active members.

  • 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.
    • profile (object) - A relationship with a single entry.
      • data* (object) - The User Agency Profile this Member represents.
        • id* (string) - The ID of the other object.

        • type* (string) - Always user-agency-profiles

          Allowed values
          • user-agency-profiles