List all contractors

GET /api/v1/contractors

Returns a list of your contractors. The contractors are returned sorted by creation date, with the most recent contractors appearing first.

Servers

• Production server: https://api.1099policy.com (Production server)

Parameters

Query parameters

• limit (integer)
  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

• starting_after (string)
  A cursor for use in pagination. starting_after is a contractor ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with cn_fOo123, your subsequent call can include starting_after=cn_fOo123 in order to fetch the next page of the list.

• ending_before (string)
  A cursor for use in pagination. ending_before is a contractor ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with cn_bAr123, your subsequent call can include ending_before=cn_bAr123 in order to fetch the previous page of the list.

• email (string)
  A case-sensitive filter on the list based on the contractor's email attribute. The value must be a string.

Responses

200

Returns an array of contractor objects. If no more contractors are available, the resulting array will be empty.

Body: application/json (array[object])

• address (object)
• company_name (string | null)
  The contractor's business name.
• created (integer(int64))
• custom_metadata (object)
  Set of key-value pairs that you can attach to the contractor object. Used for storing additional information in a structured format. Individual keys can be unset by posting an empty value to them. Pass an empty value, e.g. {}, to custom_metadata to unset all keys.
• email (string)
  The contractor's email address.
• first_name (string)
  The contractor's first name.
• id (string)
• last_name (string)
  The contractor's last name.
• middle_name (string | null)
  The contractor's middle name.
• phone (string)
  The contractor's phone number.
• withhold_premium ()
  This indicates whether the contractor is paying premium directly with their credit card (i.e., false) or if the contractor has given the platform that's integrating with 1099Policy permission to withhold the premium payment from their wages and pay the premium on the contractor's behalf (i.e., true). Defaults to false.