Questions tagged [api]
Questions about the CiviCRM API.
437
questions
0
votes
1answer
22 views
CiviCRM API explorer menu is not visibile on Wordpress
I installed CiviCRM 5.23.4 on Wordpress 5.4 and the Support menu is not visible. How do I enable and use the API explorer?
If I go to /wp-admin/admin.php?page=CiviCRM&q=civicrm/ajax/doc/api#...
0
votes
0answers
11 views
civimobile too old , while I've the latest version
I've got the message civimobileapi to old, please install a recent version
That's what I did....No result
FYI:
I've downloaded the latest recent software versions from github
Both: civomobileapi ...
3
votes
2answers
28 views
Custom API Action: Access Request Body
I'm developing a custom API v3 action which is intended to handle a webhook request from Zoom (https://marketplace.zoom.us/docs/api-reference/webhook-reference). Zoom follows REST standards by putting ...
1
vote
1answer
28 views
CiviCRM Membership data to external Database
I'm new to Joomla, CiviCRM and PHP, but looking to help with a small project. I'm looking to grab the members data from CiviCRM and transfer (or update if users already exist) into a different ...
3
votes
2answers
44 views
CiviCRM API Implementation
How are API's implemented in the CiviCRM Codebase? I have a idea of basic structue user <-> api <-> BAO <-> DAO <-> mysql but I guess there is more to this than just this structure. Thanks ...
3
votes
0answers
22 views
Get list of extensions with upgrades available (from command line)
I would like to know if it is possible to use the command-line to get a list of extensions that have upgrades available. I want to then use that to run cvapi extension.download to install the updates.
...
1
vote
1answer
16 views
outgoing sms activity link to provider when using multiple providers?
I'm testing out multiple sms providers, and I'm using the api to do reads for reporting on the back end, but I can't seem to figure out how the system knows which sms provider sent a particular sms. ...
0
votes
3answers
42 views
Activity get API3 does not return case activity
Im using API3 to get activities
My code is
function hook_any_activity_get($cid,$type) {
$params = [
'contact_id' => $cid,
'activity_type_id' => $type,
'sequential' => 1,
'...
0
votes
1answer
34 views
How to repair DB tables after faulty past upgrade?
System:
WordPress 5.2.5, CiviCRM 5.21.1, PHP 7.2.18
Background:
At some point in a previous upgrade - I suspect from 5.19.x - my database tables haven't updated properly. This resulted in my ...
0
votes
1answer
17 views
Is there a specific Exception for the API4 like CiviCRM_API3_Exception?
There is a specific Exception for the CiviCRM API3 called CiviCRM_API3_Exception. Is there a similar specific Exception for API4 or do I just catch the standard Exception?
0
votes
0answers
20 views
Issue programatically creating multiple Custom Groups(CustomGroup) with the api
When is created programmatically with API multiple entities CustomGroup, after created someones in the same process finish with the next error(the param "name" is filled), CiviCRM 5.16
[is_error] =&...
0
votes
1answer
26 views
Can I update the id of an existing OptionValue?
I'm trying to update the ID of an existing OptionValue using API v4. I get "Cannot update the id of an existing OptionValue" error. Is there another way to do that?
1
vote
0answers
24 views
Mandatory key(s) missing from params array: entity_id
Using a fairly generic CiviCRM contribution page with membership (CiviCRM 5.19.4 + Drupal 7) and CiviDiscount (3.7).
When a 100% discount code is used, instead of completing, the above error is ...
1
vote
0answers
28 views
Related membership gets deleted upon updating owner membership via API
I would like to make several people a member, linked to 1 payment
person A: membership (+ contribution)
person B: membership (related to membership person A)
$contact_a = 2;
$contact_b = 3;
$...
1
vote
0answers
19 views
Create API not updating database in new extension - what have I missed?
Help, built new extension, form displays, accepts input, but never updates the database
The returns I get from all functions do not show errors.
What the heck am I doing wrong????
It's going to be ...
1
vote
1answer
23 views
Using CIVICRM API can I get both mobile and phone number?
I am trying to work out how to call both a phone number and a mobile number using the API. I am in civicrm/api and can get one or the other but not both. Can anyone suggest a solution!?
Thanks
...
3
votes
2answers
48 views
Documentation for new sms provider?
I use NowSMS for my SMS provider instead of Twilio and Clickatell. NowSMS goes through a cell phone, which is flat rate pricing instead of per text. I've found documentation for twilio or clickatell, ...
2
votes
1answer
30 views
Retrieve Contacts with Tags in API4
I am creating some custom directory screens to display a table of contacts with associated email addresses and any tags (just a simplified directory for non-admin staff to view/sort basic CRM data). ...
1
vote
1answer
18 views
API Explorer 4 under Joomla and Windows/IIS gives fields like {{ ts('CiviCRM API v4') }}
I am running a development system under Joomla and IIS with CiviCRM 5.19.1 (5.19.0 had the same issue). When using API Explorer 4 I get windows like this.
Under LAMP, the window makes sense.
Any ...
2
votes
0answers
9 views
API: Update a specific multi value field set record
I created a custom field set with three fields, the field set does allow multiple records. The aim of this field set is to collect data about candidacies and mandates of politicians, such as the ...
2
votes
2answers
54 views
How to get data via relationships with APIv4?
Wilma has relationship: is campaigner at organisation System Change Not Charity.
How can I get a list of individuals like Wilma and the organisations that they are campaigners for?
I've read the ...
1
vote
1answer
25 views
Does the CiviCRM API comply with the OpenAPI Specification?
Does the CiviCRM API comply with the OpenAPI Specification?
3
votes
0answers
27 views
API4 authorization failure when creating a participant
I am currently trying to create a participant on a Drupal form submit, when i do this I get an error saying Authorization failed. I've tried managing the ACLs in Civi with no success, I've also ...
1
vote
1answer
26 views
Unable to list groups with CiviCRM API
When I run the API command (via CiviCRM API Explorer) to list all the "Mailing Lists" i.e.
$result = civicrm_api3('Group', 'get', ['group_type' => "Mailing List"]);
I get the full list of mailing ...
2
votes
3answers
62 views
REST API, iATS: How do I create a membership through the API without using CiviCRM's forms?
I'm building a software system that uses CiviCRM as a membership database and a billing engine for recurring dues. Our members do not have direct access to CiviCRM or the server on which it runs, and ...
1
vote
1answer
35 views
Guidance Needed on using CiviCRM API + PayPal to Complete Membership Contribution Payment
I'm at a total loss on how to make this work.
I am using the CiviCRM API to create a contact, create a membership for that contact, and even create a contribution if that person selects check, ...
4
votes
1answer
38 views
Smarty only generating nulls from API calls
Using the Explorer, I built up the smarty code I need for a template to pull in address information on a contact for use in an email:
{crmAPI var='result' entity='Address' action='get' contact_id=203}...
1
vote
1answer
35 views
Get a field label instead of value using the api
I would like to retrieve both the value as well as the label from a custom field using the api, but it only seems possible to retrieve the value.
I wonder if this is possible, would surely help me a ...
0
votes
1answer
32 views
Relative date filter possible in api?
I was wondering if it is possible to use (custom) relative date filters with the api?
For instance to find all participants of events in the current or last fiscal year.
Would save me a lot of ...
1
vote
1answer
13 views
How do I create default custom data when changing contact subtypes via the API?
If I use the API to give someone a new contact subtype it doesn't create a row in any relevant custom data tables and populate the default values. Does anyone have a good way to handle this? I have ...
2
votes
2answers
80 views
Add dupe check parameter to an API call - Contact Form 7 plugin
I've installed the Contact Form 7 CiviCRM integration plugin, and it works fine.
I'm just wondering how to add a dupe_check parameter.
If I try something like:
contact_type=Individual&source=...
1
vote
2answers
28 views
How do i properly include civicrm.settings.php to use api calls?
Quite a long time ago I wrote an external script that does this at the top:
require_once '/path/to/joomla/install/com_civicrm/civicrm.settings.php';
require_once '/path/to/joomla/install/civicrm/CRM/...
0
votes
1answer
48 views
Does CiviMobileAPI generate any logs?
I enabled CiviMobileAPI extension and Civi CRM Api Fix plug in (I'm using Wordpress) but can't login in the CiviMobile app (iOS). It keeps showing the Server API Error (Unknown error) message.
I ...
2
votes
0answers
25 views
Custom API not recognized by explorer/cv
I'm troubleshooting an issue where some custom APIs (v3) via an extension are not recognized by the site, either in the API explorer or when attempting to run them via cv. The situation is puzzling:
...
1
vote
1answer
34 views
Attachment URLs incomplete on remote server only
I'm working locally on my Mac with the latest version of CiviCRM on latest WordPress, served by MAMP. Using the API, I create an attachment to a contact, and those attachments successfully display ...
0
votes
1answer
27 views
API Contributions and Payments
I'm using the API to create Contacts start Memberships through a signup form. We are offering 1-year memberships at various price points, and I have those set up in CiviMember. My code successfully ...
2
votes
0answers
37 views
API v3 Include Some Tags and Exclude Others
I can do a custom search on Contacts to include those with a list of tags, and exclude those that also have an additional tag. And I get the results I expect.
I can't for the life of me figure out ...
1
vote
1answer
49 views
Attachment API File Upload
I'm working on a file upload of an image with a registration form. The file is being passed to PHP correctly, and I can check its properties in the $_FILES variable. I used the API Explorer to get the ...
0
votes
1answer
32 views
how do I count results in API v4
experimenting with refactoring some old code and figured I would experiment with apiv4.
the first hurdle was figuring out how to use the ArrayObject that is returned.
in apiv3, for example I would ...
1
vote
2answers
31 views
`json` parameter in the request API
The parameters in the API are confusing, especially the depth + the json paramter.
I have seen these three combinations and my question is, which variant is wrong and which is not.
I can't figure ...
1
vote
2answers
47 views
How to use PDF API in production?
(This post is following a previous question I asked and is related to ErikH's answer: https://civicrm.stackexchange.com/a/31142/6991)
Context: I want to send per email an attached amended certificate ...
2
votes
1answer
418 views
Where is the API key?
We want to connect CiviCRM with our payment processor (Twingle). We need to find the API key, the site key and the URL of the CiviCRM instance, but we can't seem to find them.
Where can we find them?
0
votes
1answer
34 views
Sharing data betweeen Multiple Databases
We have a main organisation with civi multi-site build but finding it a little complex in terms of granting permissions for various sub departments. Thee are also clashes over mailings and issues with ...
0
votes
0answers
20 views
Hook to change names of reccuring events
I am going to shut my other question and try and rewrite more clearly here.
I have recurring events. I want to change the name of these recurring events to add the date to them, so each one is easily ...
0
votes
2answers
47 views
CiviCRM 5.13.1 API v3 Merge not working
The merge API was worked on 5.0 version but after upgrade to 5.13.1 the merge is Stopped working.
Any help is very appreciate.
1
vote
1answer
27 views
Why no Member entity in the API v4 Explorer
I can't see Member or MembershipType in the API Explorer, nor can I see support for these entities in the API code. As these are pretty crucial I must be missing something - can anyone help?
2
votes
1answer
45 views
Updating Memo/Rich Text Editor Fields with the API
I have in my CiviCRM a custom field which is a memo field with a text editor. If I update the contents of this field through the user interface contents is saved correctly as html. E.g. <p>Hello ...
1
vote
0answers
11 views
How to create an v4 api using civix tool?
I am using civix tool to create an extension. I created an API using civix tool.I want to create API v4. How to create API v4?
3
votes
1answer
32 views
Getting active relationships using the API is returning contacts in trash
I'm doing this call
$result = civicrm_api3('Relationship', 'getvalue', [
'return' => "contact_id_b",
'relationship_type_id' => 5,
'contact_id_a' => "user_contact_id",
'is_active' =&...
0
votes
0answers
19 views
CIVIX: Booted CiviCRM, but failed to find 'api/class.api.php'
without apparently making any change to the environment, suddenly, the following creation of a job with civix:
php civix.phar generate: api --schedule = Daily Give ImportFromGive
fails with error:
...
