Get all contacts

With the "Get Contacts" endpoint you can receive all your created entries from your TeamGrid address book. You can filter by companies and individuals.

FieldPossible valuesDescription
_idString (17 characters long)Unique identifier
typecompany or personIndicates the type of the contact
customerIdStringindividual identifier of the contact
gendermale or female
(only available if type is person)
Gender of the person
salutationString
(only available if type is person)
Academic title of the person
firstnameString
(only available if type is person)
Firstname(s) of the person
lastnameString
(only available if type is person)
Lastname of the person
birthdayDate
(only available if type is person)
Birthday of the person
companyTitleString
(only available if type is company)
Name of the company
emailsObject[]
(see below for sub fields)
Email addresses of the contact
emails.$.typeprivate, business or otherType of the email
emails.$.emailStringEmail address
phoneNumbersObject[]
(see below for sub fields)
Phone numbers of the contact
phoneNumbers.$.typemobile, landline, business, fax, direct or otherType of the phone number
phoneNumbers.$.numberStringPhone number
addressesObject[]
(see below for sub fields)
Addresses of the contact
addresses.$.typeprivate, business or otherType of the address
addresses.$.addressObject
(see below for sub fields)
Address
addresses.$.address.fullAddressStringConcatenated values of the address
addresses.$.address.latNumberLatitude
addresses.$.address.lngNumberLongitude
addresses.$.address.streetStringStreet
addresses.$.address.street_numberStringHouse number
addresses.$.address.cityStringCity
addresses.$.address.stateStringState
addresses.$.address.zipStringZip code
addresses.$.address.countryStringCountry
websitesObject[]
(see below for sub fields)
Websites of the contact
websites.$.typeprivate, business or otherType of the website
websites.$.urlStringUrl of the website
socialNetworksObject[]
(see below for sub fields)
Accounts of the contact in social networks
socialNetworks.$.typefacebook, twitter, linkedin or xingType of the social network
socialNetworks.$.usernameStringUsername in the social network
companiesObject[]
(only available if type is person; see below for sub fields)
Companies linked to the person
companies.$.companyIdString (17 characters long)Reference to the _id of the company contact
companies.$.positionStringPosition of the person at this company
companies.$.phoneStringPhone number of the person at this company
companies.$.emailStringEmail address of the person at this company
companies.$.addresssee addresses (without the typeAddress of the person at this company
billingObject
(see below for sub fields)
Billing settings
billing.accountingObject
(see below for sub fields)
Accounting settings
billing.accounting.typeNumberType of the accounting configuration for this contact.
0: by service
1: by person
2: by hourlyRate (see billing.accounting.hourlyRate)
3: none
billing.accounting.hourlyRateNumberHourly rate for this contact. Only applies if billing.accounting.type is 2
billing.budgetObject
(see below for sub fields)
Budget settings
billing.budget.typeNumberType of the budget configuration of this contact.
0: by hours
1: by fees
4: hours per month
5: fees per month
100: none
billing.budget.hoursNumberBudget in hours. Only applies if billing.budget.type is 0 or 4
billing.budget.feesNumberBudget in fees. Only applies if billing.budget.type is 1 or 5
billing.usersObject[]
(see below for sub fields)
Custom accounting configuration by users
billing.users.$.userIdString (17 characters long)Unique identifier of the user
billing.users.$.hourlyRateNumberIf this user create time entries assigned to the contact, this hourly rate will be applied
billing.servicesObject[]
(see below for sub fields)
Custom accounting configuration by services
billing.services.$.serviceIdString (17 characters long)Unique identifier of the service
billing.services.$.billableBooleanIndicates wether time entries, assigned to the contact and this service are billable
billing.services.$.hourlyRateNumberIf a user create time entries assigned to the contact and this service, this hourly rate will be applied
createdAtDateWhen was the contact created
createdByString (17 characters long)Unique identifier of the user who created this contact
Language
Credentials
Header
Click Try It! to start a request and see the response here!