Knowledge Base
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.
Orbit API

CSV Import for Members and Activities

To import several members to your workspace at once, add first all the members to a CSV file. Navigate to the Workspace Settings page, click the Import tab, then Import CSV.

The Import Members via CSV button from the Import page is outlined.The Import Activities via CSV button from the Import page is outlined.
The Import Members and Activities via CSV buttons from the Import page are outlined

Expected CSV formats

Need a hand? Use this Google Sheet template to kickstart uploading Activities or Members via CSV.

Members

NOTE: Be sure to quote column data that contains a comma, such as tags.

At least one of the following is required:

ColumnTypeDescription
nameTextThe full name for the member
emailTextThe email address for the member
githubTextThe Github username for the member
twitterTextThe Twitter username for the member
linkedinTextThe LinkedIn username for the member
discourseTextThe Discourse username for the member

The following columns are optional:

ColumnTypeDescription
bioTextThe member's bio
birthdayTextThe member's birthday
companyTextThe member's company
titleTextThe member's title at the company
locationTextThe member's location
pronounsTextThe member's pronouns
shipping_addressTextThe member's shipping address. The address should be in quotes and not contain line breaks.
tshirtTextThe member's T-Shirt size
urlTextThe member's website
avatar_urlTextLink to the member's avatar
teammateBooleanWhether the member is a teammate or not
tagsArray (Text)Tags to associate with the member (e.g. "tag1,tag2,tag3"). Will override existing tags. Even if only adding one tag, it should still be in quotes (eg. "tag1").
tags_to_addArray (Text)Tags to associate with the member (e.g. "tag1,tag2,tag3"). Will append to existing tags. Even if only adding one tag, it should still be in quotes (eg. "tag1").

Activities

NOTE: Be sure to quote column data that contains a comma, such as tags.

When uploading activities via CSV, adding a title is required.

ColumnTypeDescription
titleTextA title for the activity; displayed in the timeline
nameTestThe name of the member associated with this activity

In addition to a title and the name of the member, at least one of the following identities is also required.

ColumnTypeDescription
emailTextThe email address for the member associated with this activity
githubTextThe GitHub username for the member associated with this activity
twitterTextThe Twitter username for the member associated with this activity
linkedinTextThe LinkedIn username for the member associated with this activity
discourseTextThe Discourse username for the member associated with this activity

You can optionally include any of the following columns. However, we recommend using as many as possible.

ColumnTypeDescription
descriptionTextA description of the activity; displayed in the timeline
linkTextA URL for the activity; displayed in the timeline
link_textTextThe text for the timeline link if you don't want to display the full URL of link
typeTextThe activity type - what action was done by the member
weightNumberA custom weight to be used in filters and reports; defaults to 1.
keyTextSupply a key that must be unique or leave blank to have one generated
occurred_atTextThe date and time the activity occurred; defaults to now. You can format this as dd/mm/yyyy or use any ISO8601 date format.
pinnedBooleanWhether or or not this activity should be pinned to the associated member timeline (use 1 for true or 0 for false)
member_tagsArray (Text)Tags to associate with the member enclosed with quotes (e.g. "tag1,tag2,tag3"). Will override existing tags. Even if only adding one tag, it should still be in quotes (eg. "tag1").
member_tags_to_addArray (Text)Tags to associate with the member enclosed with quotes (e.g. "tag1,tag2,tag3"). Will append to existing tags. Even if only adding one tag, it should still be in quotes (eg. "tag1").
📘Having trouble importing a CSV file?
Head to the Troubleshooting CSV imports section to read about common issues and how to fix them.

Related articles

Still stuck?
or